home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / File / Passwd.php < prev    next >
PHP Script  |  2004-10-01  |  14KB  |  413 lines
  1. <?php
  2. // +----------------------------------------------------------------------+
  3. // | PEAR :: File :: Passwd                                               |
  4. // +----------------------------------------------------------------------+
  5. // | This source file is subject to version 3.0 of the PHP license,       |
  6. // | that is available at http://www.php.net/license/3_0.txt              |
  7. // | If you did not receive a copy of the PHP license and are unable      |
  8. // | to obtain it through the world-wide-web, please send a note to       |
  9. // | license@php.net so we can mail you a copy immediately.               |
  10. // +----------------------------------------------------------------------+
  11. // | Copyright (c) 2003-2004 Michael Wallner <mike@iworks.at>             |
  12. // +----------------------------------------------------------------------+
  13. //
  14. // $Id: Passwd.php,v 1.21 2004/03/16 14:13:27 mike Exp $
  15.  
  16. /**
  17. * Manipulate many kinds of passwd files.
  18. * 
  19. * @author       Michael Wallner <mike@php.net>
  20. * @package      File_Passwd
  21. * @category     FileSystem
  22. */
  23.  
  24. /**
  25. * Requires PEAR.
  26. */
  27. require_once 'PEAR.php';
  28.  
  29. /**
  30. * Encryption constants.
  31. */
  32. // SHA encryption.
  33. define('FILE_PASSWD_SHA',   'sha');
  34. // MD5 encryption
  35. define('FILE_PASSWD_MD5',   'md5');
  36. // DES encryption
  37. define('FILE_PASSWD_DES',   'des');
  38. // NT hash encryption.
  39. define('FILE_PASSWD_NT',    'nt');
  40. // LM hash encryption.
  41. define('FILE_PASSWD_LM',    'lm');
  42. // PLAIN (no encryption)
  43. define('FILE_PASSWD_PLAIN', 'plain');
  44.  
  45. /**
  46. * Error constants.
  47. */
  48. // Undefined error.
  49. define('FILE_PASSWD_E_UNDEFINED',                   0);
  50. // Invalid file format.
  51. define('FILE_PASSWD_E_INVALID_FORMAT',              1);
  52. define('FILE_PASSWD_E_INVALID_FORMAT_STR',          'Passwd file has invalid format.');
  53. // Invalid extra property.
  54. define('FILE_PASSWD_E_INVALID_PROPERTY',            2);
  55. define('FILE_PASSWD_E_INVALID_PROPERTY_STR',        'Invalid property \'%s\'.');
  56. // Invalid characters.
  57. define('FILE_PASSWD_E_INVALID_CHARS',               3);
  58. define('FILE_PASSWD_E_INVALID_CHARS_STR',           '%s\'%s\' contains illegal characters.');
  59. // Invalid encryption mode.
  60. define('FILE_PASSWD_E_INVALID_ENC_MODE',            4);
  61. define('FILE_PASSWD_E_INVALID_ENC_MODE_STR',        'Encryption mode \'%s\' not supported.');
  62. // Exists already.
  63. define('FILE_PASSWD_E_EXISTS_ALREADY',              5);
  64. define('FILE_PASSWD_E_EXISTS_ALREADY_STR',          '%s\'%s\' already exists.');
  65. // Exists not.
  66. define('FILE_PASSWD_E_EXISTS_NOT',                  6);
  67. define('FILE_PASSWD_E_EXISTS_NOT_STR',              '%s\'%s\' doesn\'t exist.');
  68. // User not in group.
  69. define('FILE_PASSWD_E_USER_NOT_IN_GROUP',           7);
  70. define('FILE_PASSWD_E_USER_NOT_IN_GROUP_STR',       'User \'%s\' doesn\'t exist in group \'%s\'.');
  71. // User not in realm.
  72. define('FILE_PASSWD_E_USER_NOT_IN_REALM',           8);
  73. define('FILE_PASSWD_E_USER_NOT_IN_REALM_STR',       'User \'%s\' doesn\'t exist in realm \'%s\'.');
  74. // Parameter must be of type array.
  75. define('FILE_PASSWD_E_PARAM_MUST_BE_ARRAY',         9);
  76. define('FILE_PASSWD_E_PARAM_MUST_BE_ARRAY_STR',     'Parameter %s must be of type array.');
  77. // Method not implemented.
  78. define('FILE_PASSWD_E_METHOD_NOT_IMPLEMENTED',      10);
  79. define('FILE_PASSWD_E_METHOD_NOT_IMPLEMENTED_STR',  'Method \'%s()\' not implemented.');
  80. // Directory couldn't be created.
  81. define('FILE_PASSWD_E_DIR_NOT_CREATED',             11);
  82. define('FILE_PASSWD_E_DIR_NOT_CREATED_STR',         'Couldn\'t create directory \'%s\'.');
  83. // File couldn't be opened.
  84. define('FILE_PASSWD_E_FILE_NOT_OPENED',             12);
  85. define('FILE_PASSWD_E_FILE_NOT_OPENED_STR',         'Couldn\'t open file \'%s\'.');
  86. // File coudn't be locked.
  87. define('FILE_PASSWD_E_FILE_NOT_LOCKED',             13);
  88. define('FILE_PASSWD_E_FILE_NOT_LOCKED_STR',         'Couldn\'t lock file \'%s\'.');
  89. // File couldn't be unlocked.
  90. define('FILE_PASSWD_E_FILE_NOT_UNLOCKED',           14);
  91. define('FILE_PASSWD_E_FILE_NOT_UNLOCKED_STR',       'Couldn\'t unlock file.');
  92. // File couldn't be closed.
  93. define('FILE_PASSWD_E_FILE_NOT_CLOSED',             15);
  94. define('FILE_PASSWD_E_FILE_NOT_CLOSED_STR',         'Couldn\'t close file.');
  95.  
  96. /**
  97. * Allowed 64 chars for salts
  98. */
  99. $GLOBALS['_FILE_PASSWD_64'] =
  100.     './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
  101.  
  102. /**
  103. * The package File_Passwd provides classes and methods 
  104. * to handle many different kinds of passwd files.
  105. * 
  106. * The File_Passwd class in certain is a factory container for its special 
  107. * purpose extension classes, each handling a specific passwd file format.
  108. * It also provides a static method for reasonable fast user authentication.
  109. * Beside that it offers some encryption methods used by the extensions.
  110. *
  111. * @author       Michael Wallner <mike@php.net>
  112. * @version      $Revision: 1.21 $
  113. * 
  114. * Usage Example:
  115. * <code>
  116. *  $passwd = &File_Passwd::factory('Unix');
  117. * </code>
  118. */
  119. class File_Passwd
  120. {
  121.     /**
  122.     * Get API version
  123.     *
  124.     * @static
  125.     * @access   public
  126.     * @return   string          API version
  127.     */
  128.     function apiVersion()
  129.     {
  130.         return '1.0.0';
  131.     }
  132.  
  133.     /**
  134.     * Generate salt
  135.     *
  136.     * @access   public
  137.     * @return   mixed
  138.     * @param    int     $length     salt length
  139.     * @return   string  the salt
  140.     */
  141.     function salt($length = 2)
  142.     {
  143.         $salt = '';
  144.         $length = (int) $length;
  145.         $length < 2 && $length = 2;
  146.         for($i = 0; $i < $length; $i++) {
  147.             $salt .= $GLOBALS['_FILE_PASSWD_64'][rand(0, 63)];
  148.         }
  149.         return $salt;
  150.     }
  151.  
  152.     /**
  153.     * No encryption (plaintext)
  154.     *
  155.     * @access   public
  156.     * @return   string  plaintext input
  157.     * @param    string  plaintext passwd
  158.     */
  159.     function crypt_plain($plain)
  160.     {
  161.         return $plain;
  162.     }
  163.     
  164.     /**
  165.     * DES encryption
  166.     *
  167.     * @static
  168.     * @access   public
  169.     * @return   string  crypted text
  170.     * @param    string  $plain  plaintext to encrypt
  171.     * @param    string  $salt   the salt to use for encryption (2 chars)
  172.     */
  173.     function crypt_des($plain, $salt = null)
  174.     {
  175.         (is_null($salt) || strlen($salt) < 2) && $salt = File_Passwd::salt(2);
  176.         return crypt($plain, $salt);
  177.     }
  178.     
  179.     /**
  180.     * MD5 encryption
  181.     *
  182.     * @static
  183.     * @access   public
  184.     * @return   string  crypted text
  185.     * @param    string  $plain  plaintext to encrypt
  186.     * @param    string  $salt   the salt to use for encryption 
  187.     *                           (>2 chars starting with $1$)
  188.     */
  189.     function crypt_md5($plain, $salt = null)
  190.     {
  191.         if (
  192.             is_null($salt) || 
  193.             strlen($salt) < 3 || 
  194.             !preg_match('/^\$1\$/', $salt))
  195.         {
  196.             $salt = '$1$' . File_Passwd::salt(8);
  197.         }
  198.         return crypt($plain, $salt);
  199.     }
  200.     
  201.     /**
  202.     * SHA1 encryption
  203.     *
  204.     * Returns a PEAR_Error if sha1() is not available (PHP<4.3).
  205.     * 
  206.     * @static
  207.     * @throws   PEAR_Error
  208.     * @access   public
  209.     * @return   mixed   crypted string or PEAR_Error
  210.     * @param    string  $plain  plaintext to encrypt
  211.     */
  212.     function crypt_sha($plain)
  213.     {
  214.         if (!function_exists('sha1')) {
  215.             return PEAR::raiseError(
  216.                 'SHA1 encryption is not available (PHP < 4.3).',
  217.                 FILE_PASSWD_E_INVALID_ENC_MODE
  218.             );
  219.         }
  220.         return '{SHA}' . base64_encode(
  221.             File_Passwd::_hexbin(sha1($plain))
  222.         );
  223.  
  224.     }
  225.         
  226.     /**
  227.     * APR compatible MD5 encryption
  228.     *
  229.     * @access   public
  230.     * @return   mixed
  231.     * @param    string  $plain  plaintext to crypt
  232.     * @param    string  $salt   the salt to use for encryption
  233.     */
  234.     function crypt_apr_md5($plain, $salt = null)
  235.     {
  236.         if (is_null($salt)) {
  237.             $salt = File_Passwd::salt(8);
  238.         } elseif (preg_match('/^\$apr1\$/', $salt)) {
  239.             $salt = preg_replace('/^\$apr1\$([^$]+)\$.*/', '\\1', $salt);
  240.         } else {
  241.             $salt = substr($salt, 0,8);
  242.         }
  243.         
  244.         $length     = strlen($plain);
  245.         $context    = $plain . '$apr1$' . $salt;
  246.         $binary     = File_Passwd::_hexbin(md5($plain . $salt . $plain));
  247.         
  248.         for ($i = $length; $i > 0; $i -= 16) {
  249.             $context .= substr($binary, 0, ($i > 16 ? 16 : $i));
  250.         }
  251.         for ( $i = $length; $i > 0; $i >>= 1) {
  252.             $context .= ($i & 1) ? chr(0) : $plain[0];
  253.         }
  254.         
  255.         $binary = File_Passwd::_hexbin(md5($context));
  256.         
  257.         for($i = 0; $i < 1000; $i++) {
  258.             $new = ($i & 1) ? $plain : substr($binary, 0,16);
  259.             if ($i % 3) {
  260.                 $new .= $salt;
  261.             }
  262.             if ($i % 7) {
  263.                 $new .= $plain;
  264.             }
  265.             $new .= ($i & 1) ? substr($binary, 0,16) : $plain;
  266.             $binary = File_Passwd::_hexbin(md5($new));
  267.         }
  268.         
  269.         $p = array();
  270.         for ($i = 0; $i < 5; $i++) {
  271.             $k = $i + 6;
  272.             $j = $i + 12;
  273.             if ($j == 16) {
  274.                 $j = 5;
  275.             }
  276.             $p[] = File_Passwd::_64(
  277.                 (ord($binary[$i]) << 16) |
  278.                 (ord($binary[$k]) << 8) |
  279.                 (ord($binary[$j])),
  280.                 5
  281.             );
  282.         }
  283.         
  284.         return 
  285.             '$apr1$' . $salt . '$' . implode($p) . 
  286.             File_Passwd::_64(ord($binary[11]), 3);
  287.     }
  288.  
  289.     /**
  290.     * Convert hexadecimal string to binary data
  291.     *
  292.     * @static
  293.     * @access   private
  294.     * @return   mixed
  295.     * @param    string  $hex
  296.     */
  297.     function _hexbin($hex)
  298.     {
  299.         $rs = '';
  300.         $ln = strlen($hex);
  301.         for($i = 0; $i < $ln; $i += 2) {
  302.             $rs .= chr(hexdec($hex{$i} . $hex{$i+1}));
  303.         }
  304.         return $rs;
  305.     }
  306.     
  307.     /**
  308.     * Convert to allowed 64 characters for encryption
  309.     *
  310.     * @static
  311.     * @access   private
  312.     * @return   string
  313.     * @param    string  $value
  314.     * @param    int     $count
  315.     */
  316.     function _64($value, $count)
  317.     {
  318.         $result = '';
  319.         while(--$count) {
  320.             $result .= $GLOBALS['_FILE_PASSWD_64'][$value & 0x3f];
  321.             $value >>= 6;
  322.         }
  323.         return $result;
  324.     }
  325.  
  326.     /**
  327.     * Factory for new extensions
  328.     * 
  329.     * o Unix        for standard Unix passwd files
  330.     * o CVS         for CVS pserver passwd files
  331.     * o SMB         for SMB server passwd files
  332.     * o Authbasic   for AuthUserFiles
  333.     * o Authdigest  for AuthDigestFiles
  334.     * o Custom      for custom formatted passwd files
  335.     * 
  336.     * Returns a PEAR_Error if the desired class/file couldn't be loaded.
  337.     * 
  338.     * @static   use &File_Passwd::factory() for instantiating your passwd object
  339.     * 
  340.     * @throws   PEAR_Error
  341.     * @access   public
  342.     * @return   object    File_Passwd_$class - desired Passwd object
  343.     * @param    string    $class the desired subclass of File_Passwd
  344.     */
  345.     function &factory($class)
  346.     {
  347.         $class = ucFirst(strToLower($class));
  348.         if (!@include_once "File/Passwd/$class.php") {
  349.             return PEAR::raiseError("Couldn't load file Passwd/$class.php", 0);
  350.         }
  351.         $class = 'File_Passwd_'.$class;
  352.         if (!class_exists($class)) {
  353.             return PEAR::raiseError("Couldn't load class $class.", 0);
  354.         }
  355.         $instance = &new $class();
  356.         return $instance;
  357.     }
  358.     
  359.     /**
  360.     * Fast authentication of a certain user
  361.     * 
  362.     * Though this approach should be reasonable fast, it is NOT
  363.     * with APR compatible MD5 encryption used for htpasswd style
  364.     * password files encrypted in MD5. Generating one MD5 password
  365.     * takes about 0.3 seconds!
  366.     * 
  367.     * Returns a PEAR_Error if:
  368.     *   o file doesn't exist
  369.     *   o file couldn't be opened in read mode
  370.     *   o file couldn't be locked exclusively
  371.     *   o file couldn't be unlocked (only if auth fails)
  372.     *   o file couldn't be closed (only if auth fails)
  373.     *   o invalid <var>$type</var> was provided
  374.     *   o invalid <var>$opt</var> was provided
  375.     * 
  376.     * Depending on <var>$type</var>, <var>$opt</var> should be:
  377.     *   o Smb:          encryption method (NT or LM)
  378.     *   o Unix:         encryption method (des or md5)
  379.     *   o Authbasic:    encryption method (des, sha or md5)
  380.     *   o Authdigest:   the realm the user is in
  381.     *   o Cvs:          n/a (empty)
  382.     *   o Custom:       array of 2 elements: encryption function and delimiter
  383.     * 
  384.     * @static   call this method statically for a reasonable fast authentication
  385.     * 
  386.     * @throws   PEAR_Error
  387.     * @access   public
  388.     * @return   return      mixed   true if authenticated, 
  389.     *                               false if not or PEAR_error
  390.     * 
  391.     * @param    string      $type   Unix, Cvs, Smb, Authbasic or Authdigest
  392.     * @param    string      $file   path to passwd file
  393.     * @param    string      $user   the user to authenticate
  394.     * @param    string      $pass   the plaintext password
  395.     * @param    mixed       $opt    o Smb:          NT or LM
  396.     *                               o Unix:         des or md5
  397.     *                               o Authbasic     des, sha or md5
  398.     *                               o Authdigest    realm the user is in
  399.     *                               o Custom        encryption function and
  400.     *                                               delimiter character
  401.     */
  402.     function staticAuth($type, $file, $user, $pass, $opt = '')
  403.     {
  404.         $type = ucFirst(strToLower($type));
  405.         if (!@include_once "File/Passwd/$type.php") {
  406.             return PEAR::raiseError("Couldn't load file Passwd/$type.php", 0);
  407.         }
  408.         $func = array('File_Passwd_' . $type, 'staticAuth');
  409.         return call_user_func($func, $file, $user, $pass, $opt);
  410.     }
  411. }
  412. ?>
  413.